glossary: Add more abbreviations #19213

dveeden · 2024-10-25T12:44:22Z

What is changed, added or deleted? (Required)

Closes #19212

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

What is the related PR or file link(s)?

This PR is translated from:
Other reference link(s):

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

dveeden · 2024-10-28T09:06:13Z

@qiancai what about the HTTP 403 in the linkChecker? Is that ok?

qiancai · 2024-10-28T10:09:07Z

@qiancai what about the HTTP 403 in the linkChecker? Is that ok?

The linkChecker sometimes reports false errors due to network connectivity issues😂. I checked https://www.gartner.com/en/information-technology/glossary/htap-enabling-memory-computing-technologies and found it is accessible, so we can ignore the HTTP 403 error there.

glossary.md

Co-authored-by: Mattias Jonsson <[email protected]>

mjonss

LGTM, with some suggestions.

glossary.md

ti-chi-bot · 2024-10-29T10:16:22Z

@mjonss: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

LGTM, with some suggestions.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Co-authored-by: Mattias Jonsson <[email protected]>

qiancai · 2024-11-01T07:54:16Z

Hi @dveeden thanks for creating this PR. I've submitted bd23974 (#19213) as editorial comments. PTAL. Thanks.

glossary.md

dveeden · 2024-11-01T08:02:46Z

Hi @dveeden thanks for creating this PR. I've submitted bd23974 (#19213) as editorial comments. PTAL. Thanks.

This is a great improvement. Thanks.

For DR the included link looks weird, why is that?

Looks like the linkChecker also doesn't like it:

 * [ERR] [file:///home/runner/work/docs/docs/dr-solution-introduction](file:///home/runner/work/docs/docs/dr-solution-introduction) | Failed: Cannot find file

benmeadowcroft

As requested I have left my comments on the PR.
I really appreciate the effort to update these areas of the documentation, I made a few suggestions for your consideration.

glossary.md

benmeadowcroft · 2024-11-01T17:47:06Z

glossary.md

+
+### URI
+
+Uniform Resource Identifier (URI) is a standardized format for identifying a resource. For more information, see [Uniform Resource Identifier](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) on Wikipedia.


Why do we want to include this definition in the glossary?

This is because it is mentioned in our docs quite often. I would assume URI/URL could be considered common knowledge and left out. I'm fine with it either way.

$ git grep -cw URI | sed "s/:/\t/" | sort -k2 -r | head ticdc/ticdc-sink-to-mysql.md 7 tidb-cloud/config-s3-and-gcs-access.md 6 tidb-cloud/changefeed-sink-to-cloud-storage.md 6 ticdc/ticdc-sink-to-kafka.md 6 dumpling-overview.md 6 br/br-pitr-manual.md 5 tiproxy/tiproxy-api.md 4 tidb-cloud/tidb-cloud-auditing.md 4 tidb-cloud/migrate-sql-shards.md 4 tidb-cloud/migrate-from-op-tidb.md 4

@qiancai @benmeadowcroft should we keep it or not? It is something well known and not TiDB specific. But on the other hand, it is often mentioned in the docs.

glossary.md

Co-authored-by: Grace Cai <[email protected]>

dveeden · 2024-11-08T08:08:02Z

Thanks for the additional improvements. While I disagree on including EC2* I think that is a minor point that is based on my personal preference and shouldn't be a blocker for this set of improvements.

* the reason I disagree is that it opens up the scope of the glossary outside of TiDB to other technologies that dilutes the purpose of the glossary (in my opinion). As we support deployment on Kubernetes, Google Cloud VMs, Azure VMs, Containers, etc. as well as EC2 they would have the same rationale for inclusion if that was the bar for inclusion. We also reference S3, Azure Blob Storage, and Google Cloud Storage in our docs so there would also be a case for inclusion there by the same standard. My preference would essentially be that we keep the glossary focused on terms directly related to TiDB and the database space.

I think we could solve this like this:

Call it AWS EC2 in our docs instead of EC2. (same for AWS S3, Azure ..., Google Cloud ...)
Not mention EC2 it in the Glossary
Maybe mention AWS in the Glossary, but I don't think that's needed.

@qiancai @benmeadowcroft would that work for you?

qiancai · 2024-11-08T08:09:20Z

Thanks for the additional improvements. While I disagree on including EC2* I think that is a minor point that is based on my personal preference and shouldn't be a blocker for this set of improvements.
* the reason I disagree is that it opens up the scope of the glossary outside of TiDB to other technologies that dilutes the purpose of the glossary (in my opinion). As we support deployment on Kubernetes, Google Cloud VMs, Azure VMs, Containers, etc. as well as EC2 they would have the same rationale for inclusion if that was the bar for inclusion. We also reference S3, Azure Blob Storage, and Google Cloud Storage in our docs so there would also be a case for inclusion there by the same standard. My preference would essentially be that we keep the glossary focused on terms directly related to TiDB and the database space.
I think we could solve this like this:

Call it AWS EC2 in our docs instead of EC2. (same for AWS S3, Azure ..., Google Cloud ...)

Not mention EC2 it in the Glossary

Maybe mention AWS in the Glossary, but I don't think that's needed.

@qiancai @benmeadowcroft would that work for you?

LGTM

dveeden · 2024-11-08T08:13:43Z

I've removed EC2 and IMDS in 64f4124

@qiancai could you do whatever is needed to make sure we use "AWS EC2" instead of "EC2" in future release notes etc?

glossary.md

Co-authored-by: Grace Cai <[email protected]>

glossary.md

Co-authored-by: Grace Cai <[email protected]>

glossary.md

Co-authored-by: Grace Cai <[email protected]>

glossary.md

Co-authored-by: xixirangrang <[email protected]>

glossary.md

Co-authored-by: Grace Cai <[email protected]> Co-authored-by: xixirangrang <[email protected]>

ti-chi-bot · 2024-11-14T06:48:47Z

[LGTM Timeline notifier]

Timeline:

2024-11-07 06:25:32.544679053 +0000 UTC m=+1108645.383834596: ☑️ agreed by qiancai.
2024-11-14 06:48:46.718637162 +0000 UTC m=+511688.909506160: ☑️ agreed by hfxsd.

glossary.md

qiancai · 2024-11-15T02:18:34Z

/approve

ti-chi-bot · 2024-11-15T02:18:43Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [qiancai]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

glossary: Add more abbreviations

956145c

dveeden requested review from mjonss and qiancai October 25, 2024 12:44

ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 25, 2024

qiancai self-assigned this Oct 28, 2024

mjonss reviewed Oct 29, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

mjonss reviewed Oct 29, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

mjonss reviewed Oct 29, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

dveeden and others added 2 commits October 29, 2024 10:51

Apply suggestions from code review

f3186ce

Co-authored-by: Mattias Jonsson <[email protected]>

Apply suggestions from code review

e4c82a5

Co-authored-by: Mattias Jonsson <[email protected]>

mjonss approved these changes Oct 29, 2024

View reviewed changes

dveeden and others added 3 commits October 29, 2024 11:49

Update glossary.md

7379630

Co-authored-by: Mattias Jonsson <[email protected]>

Apply suggestions from code review

9fbf684

Co-authored-by: Mattias Jonsson <[email protected]>

refine wording

bd23974

qiancai force-pushed the glossary_oct24_1 branch from f94af5e to bd23974 Compare November 1, 2024 07:52

qiancai requested a review from benmeadowcroft November 1, 2024 07:54

qiancai added type/enhancement The issue or PR belongs to an enhancement. translation/doing This PR's assignee is translating this PR. labels Nov 1, 2024

ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Nov 1, 2024

qiancai reviewed Nov 1, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

GCP KMS -> Google Cloud KMS

fc1402c

benmeadowcroft reviewed Nov 1, 2024

View reviewed changes

dveeden added 2 commits November 6, 2024 08:15

Update based on review

c3c192a

Updated RocksDB link

d0ef6ee

qiancai reviewed Nov 8, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

Update glossary.md

091940d

Co-authored-by: Grace Cai <[email protected]>

Remove AWS related items

64f4124

qiancai reviewed Nov 11, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

Update glossary.md

78b9fba

Co-authored-by: Grace Cai <[email protected]>

qiancai reviewed Nov 13, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

Update glossary.md

ab2d8e1

Co-authored-by: Grace Cai <[email protected]>

qiancai reviewed Nov 13, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

glossary.md Outdated Show resolved Hide resolved

glossary.md Outdated Show resolved Hide resolved

Apply suggestions from code review

d255463

Co-authored-by: Grace Cai <[email protected]>

hfxsd added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Nov 13, 2024

hfxsd reviewed Nov 13, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

Update glossary.md

4b9c2df

Co-authored-by: xixirangrang <[email protected]>

hfxsd reviewed Nov 14, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

hfxsd reviewed Nov 14, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

hfxsd reviewed Nov 14, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

Apply suggestions from code review

6e9c295

Co-authored-by: Grace Cai <[email protected]> Co-authored-by: xixirangrang <[email protected]>

hfxsd approved these changes Nov 14, 2024

View reviewed changes

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Nov 14, 2024

qiancai reviewed Nov 14, 2024

View reviewed changes

glossary.md Outdated Show resolved Hide resolved

minor punctuation changes

fd4d6ca

ti-chi-bot bot added the approved label Nov 15, 2024

ti-chi-bot bot merged commit 85e27f3 into pingcap:master Nov 15, 2024
8 of 9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

glossary: Add more abbreviations #19213

glossary: Add more abbreviations #19213

dveeden commented Oct 25, 2024

dveeden commented Oct 28, 2024

qiancai commented Oct 28, 2024

mjonss left a comment

ti-chi-bot bot commented Oct 29, 2024

qiancai commented Nov 1, 2024

dveeden commented Nov 1, 2024 •

edited

Loading

benmeadowcroft left a comment

benmeadowcroft Nov 1, 2024

dveeden Nov 6, 2024

dveeden Nov 14, 2024

dveeden commented Nov 8, 2024

qiancai commented Nov 8, 2024

dveeden commented Nov 8, 2024

ti-chi-bot bot commented Nov 14, 2024

qiancai commented Nov 15, 2024

ti-chi-bot bot commented Nov 15, 2024


		### URI

		Uniform Resource Identifier (URI) is a standardized format for identifying a resource. For more information, see [Uniform Resource Identifier](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) on Wikipedia.

glossary: Add more abbreviations #19213

glossary: Add more abbreviations #19213

Conversation

dveeden commented Oct 25, 2024

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

dveeden commented Oct 28, 2024

qiancai commented Oct 28, 2024

mjonss left a comment

Choose a reason for hiding this comment

ti-chi-bot bot commented Oct 29, 2024

qiancai commented Nov 1, 2024

dveeden commented Nov 1, 2024 • edited Loading

benmeadowcroft left a comment

Choose a reason for hiding this comment

benmeadowcroft Nov 1, 2024

Choose a reason for hiding this comment

dveeden Nov 6, 2024

Choose a reason for hiding this comment

dveeden Nov 14, 2024

Choose a reason for hiding this comment

dveeden commented Nov 8, 2024

qiancai commented Nov 8, 2024

dveeden commented Nov 8, 2024

ti-chi-bot bot commented Nov 14, 2024

[LGTM Timeline notifier]

qiancai commented Nov 15, 2024

ti-chi-bot bot commented Nov 15, 2024

dveeden commented Nov 1, 2024 •

edited

Loading